<cl>

[This is preliminary documentation and subject to change.]

Compiles C/C++ programs using cl.exe, Microsoft's C/C++ compiler.

This task is intended for version 13.00.9466 of cl.exe.

Parameters

Attribute	Type	Description	Required
outputdir	directory	Directory where all output files are placed.	True
characterset	CharacterSet	Tells the compiler to use the specified character set.	False
managedextensions	bool	Specifies whether Managed Extensions for C++ should be enabled. The default is false.	False
options	string	Options to pass to the compiler.	False
pchfile	string	Specifies the path and/or name of the generated precompiled header file - given either relative to `outputdir` or as an absolute path.	False
failonerror	bool	Determines if task failure stops the build, or is just reported. The default is true.	False
if	bool	If true then the task will be executed; otherwise, skipped. The default is true.	False
timeout	int	The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.	False
unless	bool	Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false.	False
verbose	bool	Determines whether the task should report detailed build log messages. The default is false.	False

Framework-configurable parameters

Attribute	Type	Description	Required
exename	string	The name of the executable that should be used to launch the external program.	False
useruntimeengine	bool	Specifies whether the external program should be executed using a runtime engine, if configured. The default is false.	False

Nested Elements:

<sources>

The list of files to compile.

</sources>

<includedirs>

The list of directories in which to search for include files.

</includedirs>

<metadataincludedirs>

Directories that the compiler will search to resolve file references passed to the #using directive.

</metadataincludedirs>

<forcedusingfiles>

Specifies metadata files to reference in this compilation as an alternative to passing a file name to #using in source code.

</forcedusingfiles>

<arg>

The command-line arguments for the external program.

Contains a collection of <arg> elements.

</arg>

Examples

Compiles helloworld.cpp for the Common Language Runtime.

<cl outputdir="build" options="/clr">
    <sources>
        <include name="helloworld.cpp" />
    </sources>
</cl>

Requirements

Assembly: NAnt.VisualCppTasks (0.85.1714.0)